

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Telemetry Module &mdash; Ceph Documentation</title>
  

  
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/doctools.js"></script>
        <script src="../../_static/sphinx_highlight.js"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../../genindex/" />
    <link rel="search" title="Search" href="../../search/" />
    <link rel="next" title="iostat" href="../iostat/" />
    <link rel="prev" title="Telegraf Module" href="../telegraf/" /> 
</head>

<body class="wy-body-for-nav">

   
  <header class="top-bar">
    <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../">Ceph 管理器守护进程</a></li>
      <li class="breadcrumb-item active">Telemetry Module</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../../_sources/mgr/telemetry.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
  </header>
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #eee" >
          

          
            <a href="../../" class="icon icon-home"> Ceph
          

          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../start/">Ceph 简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install/">安装 Ceph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephadm/">Cephadm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rados/">Ceph 存储集群</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephfs/">Ceph 文件系统</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rbd/">Ceph 块设备</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../radosgw/">Ceph 对象网关</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../">Ceph 管理器守护进程</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../administrator/">安装和配置</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/">模块编程</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestrator_modules/">编写 orchestrator 插件</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dashboard/">仪表盘模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../ceph_api/">Ceph RESTful API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../alerts/">Alerts 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../diskprediction/">DiskPrediction 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../localpool/">localpool 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../prometheus/">Prometheus 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../influx/">Influx 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../hello/">Hello 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../telegraf/">Telegraf 模块</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Telemetry 模块</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#channels">Channels</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enabling-telemetry">Enabling Telemetry</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sample-report">Sample report</a></li>
<li class="toctree-l3"><a class="reference internal" href="#collections">Collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="#interval">Interval</a></li>
<li class="toctree-l3"><a class="reference internal" href="#status">Status</a></li>
<li class="toctree-l3"><a class="reference internal" href="#manually-sending-telemetry">Manually sending telemetry</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sending-telemetry-through-a-proxy">Sending telemetry through a proxy</a></li>
<li class="toctree-l3"><a class="reference internal" href="#contact-and-description">Contact and Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#leaderboard">Leaderboard</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../iostat/">Iostat 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../crash/">Crash 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../insights/">Insights 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestrator/">Orchestrator 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rook/">Rook 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rgw/">RGW 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../mds_autoscaler/">MDS Autoscaler 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../nfs/">NFS 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../smb/">SMB module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../progress/">Progress 模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli_api/">CLI API 命令模块</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dashboard/">Ceph 仪表盘</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../monitoring/">监控概览</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api/">API 文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../architecture/">体系结构</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/developer_guide/">开发者指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/internals/">Ceph 内幕</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../governance/">项目管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../foundation/">Ceph 基金会</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ceph-volume/">ceph-volume</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/general/">Ceph 版本（总目录）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/">Ceph 版本（索引）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security/">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../hardware-monitoring/">硬件监控</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary/">Ceph 术语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../jaegertracing/">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../translation_cn/">中文版翻译资源</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../">Ceph</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
<div id="dev-warning" class="admonition note">
  <p class="first admonition-title">Notice</p>
  <p class="last">This document is for a development version of Ceph.</p>
</div>
  <div id="docubetter" align="right" style="padding: 5px; font-weight: bold;">
    <a href="https://pad.ceph.com/p/Report_Documentation_Bugs">Report a Documentation Bug</a>
  </div>

  
  <section id="telemetry-module">
<span id="telemetry"></span><h1>Telemetry Module<a class="headerlink" href="#telemetry-module" title="Permalink to this heading"></a></h1>
<p>The telemetry module sends anonymous data about the cluster back to the Ceph
developers to help understand how Ceph is used and what problems users may
be experiencing.</p>
<p>This data is visualized on <a class="reference external" href="https://telemetry-public.ceph.com/">public dashboards</a>
that allow the community to quickly see summary statistics on how many clusters
are reporting, their total capacity and OSD count, and version distribution
trends.</p>
<section id="channels">
<h2>Channels<a class="headerlink" href="#channels" title="Permalink to this heading"></a></h2>
<p>The telemetry report is broken down into several “channels”, each with
a different type of information.  Assuming telemetry has been enabled,
individual channels can be turned on and off.  (If telemetry is off,
the per-channel setting has no effect.)</p>
<ul>
<li><p><strong>basic</strong> (default: on): Basic information about the cluster</p>
<blockquote>
<div><ul class="simple">
<li><p>capacity of the cluster</p></li>
<li><p>number of monitors, managers, OSDs, MDSs, object gateways, or other daemons</p></li>
<li><p>software version currently being used</p></li>
<li><p>number and types of RADOS pools and CephFS file systems</p></li>
<li><p>names of configuration options that have been changed from their
default (but <em>not</em> their values)</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>crash</strong> (default: on): Information about daemon crashes, including</p>
<blockquote>
<div><ul class="simple">
<li><p>type of daemon</p></li>
<li><p>version of the daemon</p></li>
<li><p>operating system (OS distribution, kernel version)</p></li>
<li><p>stack trace identifying where in the Ceph code the crash occurred</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>device</strong> (default: on): Information about device metrics, including</p>
<blockquote>
<div><ul class="simple">
<li><p>anonymized SMART metrics</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>ident</strong> (default: off): User-provided identifying information about
the cluster</p>
<blockquote>
<div><ul class="simple">
<li><p>cluster description</p></li>
<li><p>contact email address</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>perf</strong> (default: off): Various performance metrics of a cluster, which can be used to</p>
<blockquote>
<div><ul class="simple">
<li><p>reveal overall cluster health</p></li>
<li><p>identify workload patterns</p></li>
<li><p>troubleshoot issues with latency, throttling, memory management, etc.</p></li>
<li><p>monitor cluster performance by daemon</p></li>
</ul>
</div></blockquote>
</li>
</ul>
<p>The data being reported does <em>not</em> contain any sensitive
data like pool names, object names, object contents, hostnames, or device
serial numbers.</p>
<p>It contains counters and statistics on how the cluster has been
deployed, the version of Ceph, the distribution of the hosts and other
parameters which help the project to gain a better understanding of
the way Ceph is used.</p>
<p>Data is sent secured to <em>https://telemetry.ceph.com</em>.</p>
<p>Individual channels can be enabled or disabled with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">basic</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">crash</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">device</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">ident</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">perf</span>

<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">basic</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">crash</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">device</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">ident</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">perf</span>
</pre></div>
</div>
<p>Multiple channels can be enabled or disabled with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="n">basic</span> <span class="n">crash</span> <span class="n">device</span> <span class="n">ident</span> <span class="n">perf</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="n">basic</span> <span class="n">crash</span> <span class="n">device</span> <span class="n">ident</span> <span class="n">perf</span>
</pre></div>
</div>
<p>Channels can be enabled or disabled all at once with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="nb">all</span>
<span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">disable</span> <span class="n">channel</span> <span class="nb">all</span>
</pre></div>
</div>
<p>Please note that telemetry should be on for these commands to take effect.</p>
<p>List all channels with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">channel</span> <span class="n">ls</span>

<span class="n">NAME</span>      <span class="n">ENABLED</span>    <span class="n">DEFAULT</span>    <span class="n">DESC</span>
<span class="n">basic</span>     <span class="n">ON</span>         <span class="n">ON</span>         <span class="n">Share</span> <span class="n">basic</span> <span class="n">cluster</span> <span class="n">information</span> <span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">version</span><span class="p">)</span>
<span class="n">crash</span>     <span class="n">ON</span>         <span class="n">ON</span>         <span class="n">Share</span> <span class="n">metadata</span> <span class="n">about</span> <span class="n">Ceph</span> <span class="n">daemon</span> <span class="n">crashes</span> <span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">stack</span> <span class="n">straces</span><span class="p">,</span> <span class="n">etc</span><span class="p">)</span>
<span class="n">device</span>    <span class="n">ON</span>         <span class="n">ON</span>         <span class="n">Share</span> <span class="n">device</span> <span class="n">health</span> <span class="n">metrics</span> <span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span><span class="p">,</span> <span class="n">SMART</span> <span class="n">data</span><span class="p">,</span> <span class="n">minus</span> <span class="n">potentially</span> <span class="n">identifying</span> <span class="n">info</span> <span class="n">like</span> <span class="n">serial</span> <span class="n">numbers</span><span class="p">)</span>
<span class="n">ident</span>     <span class="n">OFF</span>        <span class="n">OFF</span>        <span class="n">Share</span> <span class="n">a</span> <span class="n">user</span><span class="o">-</span><span class="n">provided</span> <span class="n">description</span> <span class="ow">and</span><span class="o">/</span><span class="ow">or</span> <span class="n">contact</span> <span class="n">email</span> <span class="k">for</span> <span class="n">the</span> <span class="n">cluster</span>
<span class="n">perf</span>      <span class="n">ON</span>         <span class="n">OFF</span>        <span class="n">Share</span> <span class="n">various</span> <span class="n">performance</span> <span class="n">metrics</span> <span class="n">of</span> <span class="n">a</span> <span class="n">cluster</span>
</pre></div>
</div>
</section>
<section id="enabling-telemetry">
<h2>Enabling Telemetry<a class="headerlink" href="#enabling-telemetry" title="Permalink to this heading"></a></h2>
<p>To allow the <em>telemetry</em> module to start sharing data:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">on</span>
</pre></div>
</div>
<p>Please note: Telemetry data is licensed under the Community Data License
Agreement - Sharing - Version 1.0 (<a class="reference external" href="https://cdla.io/sharing-1-0/">https://cdla.io/sharing-1-0/</a>). Hence,
telemetry module can be enabled only after you add ‘--license sharing-1-0’ to
the ‘ceph telemetry on’ command.
Once telemetry is on, please consider enabling channels which are off by
default, such as the ‘perf’ channel. ‘ceph telemetry on’ output will list the
exact command to enable these channels.</p>
<p>Telemetry can be disabled at any time with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">off</span>
</pre></div>
</div>
</section>
<section id="sample-report">
<h2>Sample report<a class="headerlink" href="#sample-report" title="Permalink to this heading"></a></h2>
<p>You can look at what data is reported at any time with the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">show</span>
</pre></div>
</div>
<p>If telemetry is off, you can preview a sample report with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">preview</span>
</pre></div>
</div>
<p>Generating a sample report might take a few moments in big clusters (clusters
with hundreds of OSDs or more).</p>
<p>To protect your privacy, device reports are generated separately, and data such
as hostname and device serial number is anonymized. The device telemetry is
sent to a different endpoint and does not associate the device data with a
particular cluster. To see a preview of the device report use the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">show</span><span class="o">-</span><span class="n">device</span>
</pre></div>
</div>
<p>If telemetry is off, you can preview a sample device report with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">preview</span><span class="o">-</span><span class="n">device</span>
</pre></div>
</div>
<p>Please note: In order to generate the device report we use Smartmontools
version 7.0 and up, which supports JSON output.
If you have any concerns about privacy with regard to the information included in
this report, please contact the Ceph developers.</p>
<p>In case you prefer to have a single output of both reports, and telemetry is on, use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">show</span><span class="o">-</span><span class="nb">all</span>
</pre></div>
</div>
<p>If you would like to view a single output of both reports, and telemetry is off, use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">preview</span><span class="o">-</span><span class="nb">all</span>
</pre></div>
</div>
<p><strong>Sample report by channel</strong></p>
<p>When telemetry is on you can see what data is reported by channel with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">show</span> <span class="o">&lt;</span><span class="n">channel_name</span><span class="o">&gt;</span>
</pre></div>
</div>
<p>Please note: If telemetry is on, and &lt;channel_name&gt; is disabled, the command
above will output a sample report by that channel, according to the collections
the user is enrolled to. However this data is not reported, since the channel
is disabled.</p>
<p>If telemetry is off you can preview a sample report by channel with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">preview</span> <span class="o">&lt;</span><span class="n">channel_name</span><span class="o">&gt;</span>
</pre></div>
</div>
</section>
<section id="collections">
<h2>Collections<a class="headerlink" href="#collections" title="Permalink to this heading"></a></h2>
<p>Collections represent different aspects of data that we collect within a channel.</p>
<p>List all collections with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">collection</span> <span class="n">ls</span>

<span class="n">NAME</span>                            <span class="n">STATUS</span>                                               <span class="n">DESC</span>
<span class="n">basic_base</span>                      <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Basic</span> <span class="n">information</span> <span class="n">about</span> <span class="n">the</span> <span class="n">cluster</span> <span class="p">(</span><span class="n">capacity</span><span class="p">,</span> <span class="n">number</span> <span class="ow">and</span> <span class="nb">type</span> <span class="n">of</span> <span class="n">daemons</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">etc</span><span class="o">.</span><span class="p">)</span>
<span class="n">basic_mds_metadata</span>              <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">MDS</span> <span class="n">metadata</span>
<span class="n">basic_pool_flags</span>                <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Per</span><span class="o">-</span><span class="n">pool</span> <span class="n">flags</span>
<span class="n">basic_pool_options_bluestore</span>    <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Per</span><span class="o">-</span><span class="n">pool</span> <span class="n">bluestore</span> <span class="n">config</span> <span class="n">options</span>
<span class="n">basic_pool_usage</span>                <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Default</span> <span class="n">pool</span> <span class="n">application</span> <span class="ow">and</span> <span class="n">usage</span> <span class="n">statistics</span>
<span class="n">basic_rook_v01</span>                  <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Basic</span> <span class="n">Rook</span> <span class="n">deployment</span> <span class="n">data</span>
<span class="n">basic_stretch_cluster</span>           <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Stretch</span> <span class="n">Mode</span> <span class="n">information</span> <span class="k">for</span> <span class="n">stretch</span> <span class="n">clusters</span> <span class="n">deployments</span>
<span class="n">basic_usage_by_class</span>            <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Default</span> <span class="n">device</span> <span class="k">class</span> <span class="nc">usage</span> <span class="n">statistics</span>
<span class="n">crash_base</span>                      <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Information</span> <span class="n">about</span> <span class="n">daemon</span> <span class="n">crashes</span> <span class="p">(</span><span class="n">daemon</span> <span class="nb">type</span> <span class="ow">and</span> <span class="n">version</span><span class="p">,</span> <span class="n">backtrace</span><span class="p">,</span> <span class="n">etc</span><span class="o">.</span><span class="p">)</span>
<span class="n">device_base</span>                     <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span>                          <span class="n">Information</span> <span class="n">about</span> <span class="n">device</span> <span class="n">health</span> <span class="n">metrics</span>
<span class="n">ident_base</span>                      <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span><span class="p">,</span> <span class="n">CHANNEL</span> <span class="n">ident</span> <span class="n">IS</span> <span class="n">OFF</span>    <span class="n">User</span><span class="o">-</span><span class="n">provided</span> <span class="n">identifying</span> <span class="n">information</span> <span class="n">about</span> <span class="n">the</span> <span class="n">cluster</span>
<span class="n">perf_memory_metrics</span>             <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span><span class="p">,</span> <span class="n">CHANNEL</span> <span class="n">perf</span> <span class="n">IS</span> <span class="n">OFF</span>     <span class="n">Heap</span> <span class="n">stats</span> <span class="ow">and</span> <span class="n">mempools</span> <span class="k">for</span> <span class="n">mon</span> <span class="ow">and</span> <span class="n">mds</span>
<span class="n">perf_perf</span>                       <span class="n">NOT</span> <span class="n">REPORTING</span><span class="p">:</span> <span class="n">NOT</span> <span class="n">OPTED</span><span class="o">-</span><span class="n">IN</span><span class="p">,</span> <span class="n">CHANNEL</span> <span class="n">perf</span> <span class="n">IS</span> <span class="n">OFF</span>     <span class="n">Information</span> <span class="n">about</span> <span class="n">performance</span> <span class="n">counters</span> <span class="n">of</span> <span class="n">the</span> <span class="n">cluster</span>
</pre></div>
</div>
<p>Where:</p>
<p><strong>NAME</strong>: Collection name; prefix indicates the channel the collection belongs to.</p>
<p><strong>STATUS</strong>: Indicates whether the collection metrics are reported; this is
determined by the status (enabled / disabled) of the channel the collection
belongs to, along with the enrollment status of the collection (whether the user
is opted-in to this collection).</p>
<p><strong>DESC</strong>: General description of the collection.</p>
<p>See the diff between the collections you are enrolled to, and the new,
available collections with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">diff</span>
</pre></div>
</div>
<p>Enroll to the most recent collections with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">on</span>
</pre></div>
</div>
<p>Then enable new channels that are off with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">enable</span> <span class="n">channel</span> <span class="o">&lt;</span><span class="n">channel_name</span><span class="o">&gt;</span>
</pre></div>
</div>
</section>
<section id="interval">
<h2>Interval<a class="headerlink" href="#interval" title="Permalink to this heading"></a></h2>
<p>The module compiles and sends a new report every 24 hours by default.
You can adjust this interval with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">interval</span> <span class="mi">72</span>    <span class="c1"># report every three days</span>
</pre></div>
</div>
</section>
<section id="status">
<h2>Status<a class="headerlink" href="#status" title="Permalink to this heading"></a></h2>
<p>The see the current configuration:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">status</span>
</pre></div>
</div>
</section>
<section id="manually-sending-telemetry">
<h2>Manually sending telemetry<a class="headerlink" href="#manually-sending-telemetry" title="Permalink to this heading"></a></h2>
<p>To ad hoc send telemetry data:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">telemetry</span> <span class="n">send</span>
</pre></div>
</div>
<p>In case telemetry is not enabled (with ‘ceph telemetry on’), you need to add
‘--license sharing-1-0’ to ‘ceph telemetry send’ command.</p>
</section>
<section id="sending-telemetry-through-a-proxy">
<h2>Sending telemetry through a proxy<a class="headerlink" href="#sending-telemetry-through-a-proxy" title="Permalink to this heading"></a></h2>
<p>If the cluster cannot directly connect to the configured telemetry
endpoint (default <em>telemetry.ceph.com</em>), you can configure a HTTP/HTTPS
proxy server with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">proxy</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="mf">10.0.0.1</span><span class="p">:</span><span class="mi">8080</span>
</pre></div>
</div>
<p>You can also include a <em>user:pass</em> if needed:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">proxy</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">ceph</span><span class="p">:</span><span class="n">telemetry</span><span class="o">@</span><span class="mf">10.0.0.1</span><span class="p">:</span><span class="mi">8080</span>
</pre></div>
</div>
</section>
<section id="contact-and-description">
<h2>Contact and Description<a class="headerlink" href="#contact-and-description" title="Permalink to this heading"></a></h2>
<p>A contact and description can be added to the report.  This is
completely optional, and disabled by default.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">contact</span> <span class="s1">&#39;John Doe &lt;john.doe@example.com&gt;&#39;</span>
<span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">description</span> <span class="s1">&#39;My first Ceph cluster&#39;</span>
<span class="n">ceph</span> <span class="n">config</span> <span class="nb">set</span> <span class="n">mgr</span> <span class="n">mgr</span><span class="o">/</span><span class="n">telemetry</span><span class="o">/</span><span class="n">channel_ident</span> <span class="n">true</span>
</pre></div>
</div>
</section>
<section id="leaderboard">
<h2>Leaderboard<a class="headerlink" href="#leaderboard" title="Permalink to this heading"></a></h2>
<p>To participate in a leaderboard in the <a class="reference external" href="https://telemetry-public.ceph.com/">public dashboards</a>, run the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><style type="text/css">
span.prompt1:before {
  content: "$ ";
}
</style><span class="prompt1">ceph<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>mgr<span class="w"> </span>mgr/telemetry/leaderboard<span class="w"> </span><span class="nb">true</span></span>
</pre></div></div><p>The leaderboard displays basic information about the cluster. This includes the
total storage capacity and the number of OSDs. To add a description of the
cluster, run a command of the following form:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">ceph<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>mgr<span class="w"> </span>mgr/telemetry/leaderboard_description<span class="w"> </span><span class="s1">&#39;Ceph cluster for Computational Biology at the University of XYZ&#39;</span></span>
</pre></div></div><p>If the <code class="docutils literal notranslate"><span class="pre">ident</span></code> channel is enabled, its details will not be displayed in the
leaderboard.</p>
</section>
</section>



<div id="support-the-ceph-foundation" class="admonition note">
  <p class="first admonition-title">Brought to you by the Ceph Foundation</p>
  <p class="last">The Ceph Documentation is a community resource funded and hosted by the non-profit <a href="https://ceph.io/en/foundation/">Ceph Foundation</a>. If you would like to support this and our other efforts, please consider <a href="https://ceph.io/en/foundation/join/">joining now</a>.</p>
</div>


           </div>
           
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="../telegraf/" class="btn btn-neutral float-left" title="Telegraf Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../iostat/" class="btn btn-neutral float-right" title="iostat" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0).</p>
  </div>

   

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>